// Copyright 2024 The LUCI Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import { ReactNode } from 'react';

import { ContentGroupProvider, useContentGroup } from './context';

export interface ContentGroupProps {
  /**
   * The content group of this route.
   *
   * A descendant page view tracker will join all the content groups defined in
   * the ancestor tree (if any). This is useful when the same child route
   * component is used in multiple parent routes.
   */
  readonly group: string;
  readonly children: ReactNode;
}

/**
 * Defines the content group of a route component.
 */
export function ContentGroup({ group, children }: ContentGroupProps) {
  const parentGroup = useContentGroup();
  const selfGroup =
    parentGroup === undefined ? group : `${parentGroup} | ${group}`;

  return (
    <ContentGroupProvider value={selfGroup}>{children}</ContentGroupProvider>
  );
}
